銀行振込
(バーチャル口座 あおぞら)

銀行振込(バーチャル口座 あおぞら) API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranGANB 取引登録

オーダーIDを指定して取引を登録します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字10桁
利用金額（振込依頼金額）

税送料を指定した場合は、利用金額 + 税送料が振込依頼金額となります。

Tax 半角数字10桁
税送料（振込依頼金額）

税送料を指定した場合は、利用金額 + 税送料が振込依頼金額となります。

URL
/payment/EntryTranGANB.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranGANB 取引実行

登録された取引に対してバーチャル口座を発行します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

AccountHolderOptionalName 半角20桁
口座名義任意名

口座に付与する名義の任意名を設定します。

TradeDays 半角数字3桁
取引有効日数

TradeReason 全半角64桁
取引事由

取引の内容を設定してください。
本項目は、振込依頼メールの「利用内容」欄に記載されます。

TradeClientName 全半角64桁
振込依頼人氏名

振込依頼者の氏名を設定してください。
半角文字：英数、全角文字：英数かカ漢 が使用可能です。

TradeClientMailaddress 半角英数記号256桁
振込依頼人メールアドレス

振込依頼者のメールアドレスを設定してください。
設定した場合は、当該メールアドレスに振込依頼メールが送信されます。
未設定の場合は、お客様に対して加盟店様から振込依頼をしてください。
※振込依頼メールの詳細については、振込依頼メール仕様を参照してください。

URL
/payment/ExecTranGANB.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

BankCode 半角数字4桁 固定
銀行コード

振込先口座の銀行コードを返却します。
("0310"固定)

BankName 半角カナ15桁 固定
銀行名

振込先口座の銀行名を返却します。
("ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗﾈﾂﾄ"固定)

BranchCode 半角数字3桁
支店コード

振込先口座の支店コードを返却します。

BranchName 半角15桁
支店名

振込先口座の支店名を返却します。

AccountType 半角数字1桁 固定
預金種別

振込先口座の預金種別を返却します。
("1"：普通預金固定)

AccountNumber 半角数字7桁
口座番号

振込先口座の口座番号を返却します。

AccountHolderName 半角40桁
口座名義

振込先口座の口座名義を返却します。

AvailableDate 半角数字8桁 固定
取引有効期限

入力パラメータで指定された取引有効日数を元に算出された取引有効期限を返却します。
YYYYMMDD形式

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&BankCode=0310&BankName=ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗﾈﾂﾄ&BranchCode=503&BranchName=ｶｿｳｼﾃﾝ&AccountType=1&AccountNumber=1234567&AccountHolderName=ﾃｽﾄｺｳｻﾞ&AvailableDate=20220701
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

CancelTranGANB 取引停止

取引を停止し、バーチャル口座を削除します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/CancelTranGANB.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status 半角英字4桁
現状態

以下のステータスを返します。
・STOP：取引停止

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

TotalTransferAmount 半角数字15桁
累計入金額

本取引で発行されたバーチャル口座に対する入金の累計金額を返却します。

TotalTransferCount 半角数字10桁
累計入金回数

本取引で発行されたバーチャル口座に対する入金回数を返却します。

LatestTransferAmount 半角数字10桁
最終振込額

最後に振込された金額を返却します。

LatestTransferDate 半角数字8桁 固定
最終振込日

最後に振込された日付を返却します。
(YYYYMMDD形式)

LatestTransferName 半角48桁
最終振込依頼人名

最後に振込した依頼人名を返却します。

LatestTransferBankName 半角15桁
最終仕向銀行名

最後に振込した銀行名を返却します。

LatestTransferBranchName 半角15桁
最終仕向支店名

最後に振込した支店名を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=STOP&ClientField1=&ClientField2=&ClientField3=&TotalTransferAmount=800&TotalTransferCount=1&LatestTransferAmount=800&LatestTransferDate=20220701&LatestTransferName=ﾌﾘｺﾐｲﾗｲﾆﾝﾒｲ&LatestTransferBankName=ﾃｽﾄｷﾞﾝｺｳ&LatestTransferBranchName=ﾃｽﾄｼﾃﾝ
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

InquiryTransferGANB 入金履歴情報取得

指定された取引のバーチャル口座に対する入金情報を返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

DateFrom 半角数字8桁 固定
照会期間(開始日)

照会する期間の開始日をyyyyMMdd形式で指定します。
省略した場合は1年前(365日前)が指定されます。

DateTo 半角数字8桁 固定
照会期間(終了日)

照会する期間の終了日をyyyyMMdd形式で指定します。
省略した場合は当日が指定されます。

URL
/payment/InquiryTransferGANB.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
TransferDate 半角数字8桁 固定
振込日

振込された日付を返却します。
(yyyyMMdd形式)

TransferName 半角48桁
振込依頼人名

振込した依頼人名を返却します。

TransferBankName 半角15桁
仕向銀行名

振込した銀行名を返却します。

TransferBranchName 半角15桁
仕向支店名

振込した支店名を返却します。

TransferAmount 半角数字10桁
入金金額

入金金額を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
20220703|ﾌﾘｺﾐｲﾗｲﾆﾝﾒｲ|ﾃｽﾄｷﾞﾝｺｳ|ﾃｽﾄｼﾃﾝ|800
20220702|ﾌﾘｺﾐｲﾗｲﾆﾝﾒｲ|ﾃｽﾄｷﾞﾝｺｳ|ﾃｽﾄｼﾃﾝ|600
20220701|ﾌﾘｺﾐｲﾗｲﾆﾝﾒｲ|ﾃｽﾄｷﾞﾝｺｳ|ﾃｽﾄｼﾃﾝ|400
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定された取引の状態を返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁 固定
決済方法

"36" （銀行振込(バーチャル口座 あおぞら)）固定

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=36
レスポンス
正常
Status 半角英字11桁
現状態

UNPROCESSED : 未決済
TRADING : 取引中
PAYSUCCESS : 取引完了
STOP：取引停止
EXPIRED : 取引有効期限切れ

ProcessDate 半角数字14桁 固定
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字8桁
利用金額（振込依頼金額）

振込依頼をした金額を返却します。

Tax 半角数字7桁
税送料（振込依頼金額）

振込依頼をした金額を返却します。

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

"36"：銀行振込(バーチャル口座 あおぞら)

GanbBankCode 半角数字4桁 固定
銀行コード

"0310"固定

GanbBankName 半角カナ15桁 固定
銀行名

"ｼﾞｰｴﾑｵｰｱｵｿﾞﾗﾈｯﾄ"固定

GanbBranchCode 半角数字3桁
支店コード

GanbBranchName 半角45桁
支店名

GanbAccountType 半角数字1桁 固定
預金種別

振込先口座の預金種別を返却します。
("1"：普通預金固定)

GanbAccountNumber 半角数字7桁
口座番号

GanbAccountHolderName 半角40桁
口座名義

GanbExpireDays 半角数字3桁
取引有効日数

GanbExpireDate 半角数字8桁 固定
取引有効期限

yyyyMMdd書式

GanbTradeReason 全半角96桁
取引事由

振込依頼内容を返却します。

GanbTradeClientName 全半角64桁
取引依頼人名

取引実行時に指定した振込依頼人名を返却します。

GanbTotalTransferAmount 半角数字15桁
累計入金額

本取引で発行されたバーチャル口座に対する入金の累計金額を返却します。

GanbTotalTransferCount 半角数字10桁
累計入金回数

本取引で発行されたバーチャル口座に対する入金回数を返却します。

GanbLatestTransferAmount 半角数字10桁
最終振込額

最後に振込された金額を返却します。

GanbLatestTransferDate 半角数字8桁 固定
最終振込日

最後に振込された日付を返却します。
(yyyyMMdd形式)

GanbLatestTransferName 半角48桁
最終振込依頼人名

最後に振込した依頼人名を返却します。

GanbLatestTransferBankName 半角15桁
最終仕向銀行名

最後に振込した銀行名を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=PAYSUCCESS&ProcessDate=20220701&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=36&GanbBankCode=0310&GanbBankName=ｼﾞ-ｴﾑｵ-ｱｵｿﾞﾗﾈﾂﾄ&GanbBranchCode=503&GanbBranchName=ｶｿｳｼﾃﾝ&GanbAccountType=1&GanbAccountNumber=1234567&GanbAccountHolderName=ﾃｽﾄｺｳｻﾞ&GanbExpireDays=1&GanbExpireDate=20220701&GanbTradeReason=&GanbTradeClientName=ﾌﾘｺﾐｲﾗｲﾆﾝﾒｲ&GanbTotalTransferAmount=800&GanbTotalTransferCount=1&GanbLatestTransferAmount=&GanbLatestTransferDate=20220701&GanbLatestTransferName=ﾌﾘｺﾐｲﾗｲﾆﾝﾒｲ&GanbLatestTransferBankName=ﾃｽﾄｷﾞﾝｺｳ
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001